/**
 * Software License, Version 1.0
 * 
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 * 
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the 
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For 
 * further information contact the Community Grids Lab at 
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and 
 * wherever such third-party acknowledgments normally appear.
 * 
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering, 
 * shall not be used to endorse or promote products derived from this software 
 * without prior written permission from Indiana University.  For written 
 * permission, please contact the Advanced Research and Technology Institute 
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering, 
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 * 
 *
 * Indiana University provides no reassurances that the source code provided 
 * does not infringe the patent or any other intellectual property rights of 
 * any other entity.  Indiana University disclaims any liability to any 
 * recipient for claims brought by any other entity based on infringement of 
 * intellectual property rights or otherwise.  
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO 
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF 
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS. 
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS", 
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.  
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR 
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION 
 *GENERATED USING SOFTWARE.
 */
/**
 * 
 */
package cgl.narada.wsinfra.messaging.entity.wse;

import java.util.Enumeration;

import javax.xml.namespace.QName;
import javax.xml.soap.SOAPMessage;

import cgl.narada.wsinfra.WsMessageFlow;
import cgl.narada.wsinfra.exception.DeploymentException;
import cgl.narada.wsinfra.exception.MessageFlowException;
import cgl.narada.wsinfra.exception.ProcessingException;
import cgl.narada.wsinfra.messaging.entity.Publisher;
import cgl.narada.wsinfra.messaging.entity.PublisherDefaults;
import cgl.narada.wsinfra.messaging.interactions.PublisherWithSubscriber;
import cgl.narada.wsinfra.messaging.interactions.wse.WSEPublisherWithSubscriber;
import cgl.narada.wsinfra.messaging.widget.Subscription;
import cgl.narada.wsinfra.messaging.widget.wse.WseSubscriptionEntry;
import cgl.narada.wsinfra.schemas.addressing.EndpointReferenceType;
import cgl.narada.wsinfra.schemas.soap.EnvelopeDocument;
import cgl.narada.wsinfra.util.SoapEnvelopeConversion;
import cgl.narada.wsinfra.util.SoapMessageAlteration;
import cgl.narada.wsinfra.wse.WseQNames;
import cgl.narada.wsinfra.wse.impl.WseSourceProcessor;
import cgl.narada.wsinfra.wse.matching.SubscriptionEntry;
import cgl.narada.wsinfra.wse.matching.SubscriptionManagement;

/**
 * @author Shrideep Pallickara
 *
 */
public class WsePublisher extends WseEntity implements Publisher {

	private WseQNames wseQNames;
	private final WseSourceProcessor wseSourceProcessor = WseSourceProcessor.getInstance();
	private SubscriptionManagement subscriptionManagement;
	private WsePublisherDefaults wsePublisherDefaults;
	private WSEPublisherWithSubscriber publisherWithSubscriber;
	private SoapMessageAlteration soapMessageAlteration;
	private SoapEnvelopeConversion soapEnvelopeConversion;
	
	private EndpointReferenceType sourceEPR, subscriptionManagerEPR;
	
	private String moduleName = "WsePublisher: ";
	
	public WsePublisher(EndpointReferenceType sourceEPR, 
	                    EndpointReferenceType subscriptionManagerEPR) 
		throws DeploymentException {
		this.sourceEPR = sourceEPR;
		this.subscriptionManagerEPR = subscriptionManagerEPR;
		
		setEndpointReference(sourceEPR);

		wseSourceProcessor.setSourceEPR(sourceEPR);
		wseSourceProcessor.setSubscriptionManagerEPR(subscriptionManagerEPR);
		
		subscriptionManagement = wseSourceProcessor.getSubscriptionManagement();
		
		wsePublisherDefaults = WsePublisherDefaults.getInstance();
		publisherWithSubscriber = new WSEPublisherWithSubscriber(wseSourceProcessor);
		soapMessageAlteration = SoapMessageAlteration.getInstance();
		wseQNames = WseQNames.getInstance();
		soapEnvelopeConversion = SoapEnvelopeConversion.getInstance();
	}
	
	/**
	 * @see cgl.narada.wsinfra.messaging.entity.Publisher#publish(javax.xml.soap.SOAPMessage)
	 */
	public void publish(SOAPMessage soapMessage) throws ProcessingException,
			MessageFlowException {
		WsMessageFlow wsMessageFlow = wseSourceProcessor.getMessageFlow();
		if (wsMessageFlow == null) {
			String error = moduleName + "The WsMessageFlow has not been set!";
			throw new MessageFlowException(error);
		}
		wsMessageFlow.enrouteToNetwork(soapMessage);
	}


	/**
	 * @see cgl.narada.wsinfra.messaging.entity.Publisher#publish(cgl.narada.wsinfra.schemas.soap.EnvelopeDocument)
	 */
	public void publish(EnvelopeDocument envelopeDocument)
			throws ProcessingException, MessageFlowException {
		wseSourceProcessor.enrouteToNetwork(envelopeDocument);
	}

	
	/**
	 * @see cgl.narada.wsinfra.messaging.entity.Publisher#addTopicInfo(cgl.narada.wsinfra.schemas.soap.EnvelopeDocument, java.lang.String)
	 */
	public void addTopicInfo(EnvelopeDocument envelopeDocument, String topic)
			throws ProcessingException {
		QName qName = wseQNames.getTopicQNameNBX();
	   boolean added = soapMessageAlteration.addToSoapHeader(envelopeDocument, 
								  												qName, topic);

	    if (!added) {
	   	 String errorReport = moduleName + "Addition of Topic info NOT Successful";
	   	 throw new ProcessingException(errorReport);
	    }

	}
	
	

	/**
	 * @see cgl.narada.wsinfra.messaging.entity.Publisher#addTopicInfo(javax.xml.soap.SOAPMessage, java.lang.String)
	 */
	public void addTopicInfo(SOAPMessage soapMessage, String topic)
			throws ProcessingException {
		EnvelopeDocument envelopeDocument =
			soapEnvelopeConversion.getEnvelopeDocument(soapMessage);
		addTopicInfo(envelopeDocument, topic);
		soapMessage = soapEnvelopeConversion.getSOAPMessage(envelopeDocument);

	}

	/**
	 * @see cgl.narada.wsinfra.messaging.entity.Publisher#getSubscriberInteractions()
	 */
	public PublisherWithSubscriber getSubscriberInteractions() {
		return publisherWithSubscriber;
	}

	/**
	 * @see cgl.narada.wsinfra.messaging.entity.Publisher#getPublisherDefaults()
	 */
	public PublisherDefaults getPublisherDefaults() {
		return wsePublisherDefaults;
	}

	
	/**
	 * @see cgl.narada.wsinfra.messaging.entity.Publisher#getListOfSubscriptionIdentifiers()
	 */
	public Enumeration getListOfSubscriptionIdentifiers() {
		return subscriptionManagement.getSubscriptionIdentifiers();
	}

	
	/**
	 * @see cgl.narada.wsinfra.messaging.entity.Publisher#getSubscription(java.lang.String)
	 */
	public Subscription getSubscription(String subscriptionIdentifier)
			throws ProcessingException {
		SubscriptionEntry subscriptionEntry = subscriptionManagement.getEntry(subscriptionIdentifier);
		WseSubscriptionEntry wseEntry = new WseSubscriptionEntry(subscriptionEntry);
		return wseEntry;
	}

	/**
	 * @see cgl.narada.wsinfra.messaging.entity.Publisher#getSubscriptionManagerEPR()
	 */
	public EndpointReferenceType getSubscriptionManagerEPR() {
		return subscriptionManagerEPR;
	}
	
	
}
